Product Overview

Eclipse and the Rational® Development environment. When used with IBM® Rational Software Delivery Platform (RSDP) 7.5, or Eclipse this toolkit provides a complete,
integrated development environment for application development on desktops, laptops, and servers, with application deployment to desktops, laptops, and devices.

Lotus Expeditor Toolkit is a complete development environment in a single IDE for developing applications for the Lotus Notes® 8, Lotus Sametime®, and Lotus Expeditor Client platforms. The toolkit includes support for building Eclipse plug-ins, OSGi bundles, Web Application bundles, Portlet bundles, and Web Services clients and providers with WS-Security support. Projects and client launches can be easily managed through selection from predefined configurations. Custom configurations of the client platform can be built using the Platform Builder. Multiple samples are included. There are samples that focus on individual client services as well as samples, such as Order Entry, that show how individual client services can be combined into an end to end application.

Accessing your documentation

You can view the latest version of the documentation as well as translated documentation in the Lotus Expeditor product wiki

Supported hardware and software

To review detailed system requirements for Lotus Expeditor, visit the following URL: http://www.ibm.com/support/docview.wss?rs=899&uid=swg27015335

Limitations when using Lotus Expeditor Toolkit on Eclipse with WTP

The following list describes functionality of Lotus Expeditor Toolkit that are supported when Lotus Expeditor Toolkit is installed into RAD and RSA, but are not supported when Lotus Expeditor Toolkit is installed into Eclipse + WTP:

• Samples - The samples are implemented differently in Eclipse + WTP than in RAD. You must import the samples using the method documented in Developing Applications for Lotus Expeditor > Overview > Using the samples located in the Product Documentation section of the Lotus Expeditor product wiki
• Portlet tools - The portlet tools extend the portlet tooling that is part of RAD. Therefore, to use the portlet tooling you must install Lotus Expeditor Toolkit into RAD or RSA.
• WS-Security editors - The WS-Security editors extend the RAD security editors. You can build security enabled web services for JSR-172 by hand, without the aid of the editors. To use the editors, you must install Lotus Expeditor Toolkit into RAD or RSA. .
• Full JSF - RAD does not include the WTP implementation of the JSF tooling. RAD will continue to provide a more advanced level of JSF support. Therefore, the usage of JSF with Lotus Expeditor will differ based on the level of base ware.

Installing Lotus Expeditor Toolkit using the update site

To install Lotus Expeditor Toolkit into your IDE using an the update site on the installation media, follow these steps.

Using the Lotus Expeditor Clients with the Toolkit

To develop and test applications using the Toolkit, you must install the desired Clients on your development system.

To install the Lotus Expeditor Client for Desktop or Lotus Expeditor Client for Devices, refer to the Lotus Expeditor 6.2.1 - Client for Desktop and Client for Devices Installation Guide and Quick Reference on the Client DVD. Installation guides are also available in the Product Documentation section of the Lotus Expeditor product wiki

If you are developing applications for Lotus Notes 8 or Lotus Sametime, refer to the following Product Documentation in the Lotus Expeditor product wiki:

• Developing Lotus Expeditor Applications > Using the Lotus Expeditor Toolkit > Using the Lotus Expeditor Toolkit with Lotus Sametime
• Developing Lotus Expeditor Applications > Using the Lotus Expeditor Toolkit > Using the Lotus Expeditor Toolkit with Lotus Notes 8.0

Installing the Lotus Expeditor Desktop Development Utilities

The Development Enablement Utilities is a collection of utilities that are required to develop Lotus Expeditor Client for Desktop applications with the Lotus Expeditor Toolkit. Users who are developing applications for Lotus Expeditor Client for Devices, Lotus Notes 8 or Lotus Sametime environments do not need to install this component.

Configuring the environment

You must install the appropriate Client and the Lotus Expeditor Desktop Development Utilities (if required) before you attempt to configure the Toolkit.

When the IDE is restarted after Toolkit installation, you are prompted through a configuration dialog to set preferences for either Lotus Notes 8, Lotus Expeditor Client for Desktop, and Lotus Expeditor Client for Devices environments. Select the appropriate environment for your application type, this step is necessary to develop and deploy these types of applications. Make sure the Target Location field points to the selected environment's install location. Click OK to configure the selected environment, which will set your target platform and the appropriate JRE selected in the dialog.

Once configured, the target platform and the JRE are registered with the toolkit. This process takes approximately 1-2 minutes, depending on your system. If you choose not to configure at this time, you will be prompted to configure the next time you restart the Workbench unless you select the "Never display" option in the configuration dialog.

After configuration completes, you can begin to launch, develop and test your applications for the configured target platform.

Follow the steps in Developing Applications for Lotus Expeditor > Using the Lotus Expeditor Toolkit > Getting Started with the Lotus Expeditor toolkit in the Product Documentation of the Lotus Expeditor product wiki to configure the Lotus Expeditor Toolkit to develop applications for the Lotus Expeditor Client for Devices.

Migrating your workspace from previous versions of Lotus Expeditor Toolkit

The Lotus Expeditor Toolkit provides assistance for you to migrate the workspaces and Client Services projects from previous releases (6.x). You can migrate workspaces using Rational Application Developer (RAD) or Eclipse.

Note: Ensure that you have followed the steps to configure the environment before you migrate any workspaces or Client Services projects.

Note: In Expeditor Client for Devices versions 6.1.x, the workspace is always in the device's root directory. In later versions, the workspace is in the same directory as the Expeditor core installation. This means that if you are migrating from 6.1.x and installing Expeditor to a storage card, your workspace directory will be moved.

Refer to Developing Applications for Lotus Expeditor > Developing applications > Migrating applications in the Product
Documentation section of the Lotus Expeditor product wiki for more information.

Creating and launching your first application

These instructions assume that you are using the Lotus Expeditor Toolkit with Rational platform. You can also import samples using Eclipse. For information on using the samples in Eclipse refer to the following Product Documentation in the Lotus Expeditor product wiki:

• Developing Applications for Lotus Expeditor > Product Overview > Using the samples

To create and launch a project, follow these steps:

Lotus Expeditor Toolkit samples

The Lotus Expeditor Toolkit contains a wide variety of samples, including the Web Application sample that you just launched. Click Help > Help Contents from the main menu and select Samples from the navigation panel to set up and launch other sample applications, including:

Accounts sample

The Accounts sample creates a Client Services project to illustrate the basic elements of a rich client application that uses the Accounts API on Lotus Expeditor.

Branding sample

The Branding sample creates a Client Services project to illustrate how to brand elements of the Lotus Expeditor user interface.

Composite Application sample

The Composite Application sample creates Client Services projects to illustrate the basic elements of developing composite applications on Lotus Expeditor.

DB2® Everyplace® sample

This sample illustrates a use of the local DB2 Everyplace database.

Derby Sample

This sample illustrates the use of the local Cloudscape® database.

Echo sample

Creates a Web Service Echo Demo, which includes three projects: Echo Server, Echo Client, and Echo Marshal. These projects provide custom serialization and deserialization, also called custom marshalling. Demonstrates how to expose an OSGi service as a Web service, use custom marshalling, and access a Web service as a dynamic client.

Echo Secure sample

Creates a Web Service Echo Secure Demo, which includes three projects: Echo Server Secure, Echo Client Secure, and Register User. These projects
provide user registration for Web Services security running in the Lotus Expeditor Client environment. Demonstrates how to register an OSGi service as a secure Web service and access the service from a dynamic client.

Eclipse Preferences sample

This sample demonstrates the use of the OSGi Preferences Service to save and retrieve preference information.

Embedded Browser sample

This sample creates a Client Services project to illustrate the basic elements of launching an embedded browser with Embedded Browser API's in the Lotus Expeditor workbench.

eRCP E-mail sample

This sample shows you how to construct an embedded Rich Client Platform (eRCP) application.

eSWT Demo sample

This sample contains a number of showcase applications that show embedded Standard Widget Technology (eSWT) widgets, both alone, and combined to form some simple application functionality.

ISync sample

This sample demonstrates how to use the ISync APIs to synchronize relational data from a DB2® Everyplace® Sync Server to a local DB2 Everyplace or Cloudscape™ database

JMS with Lotus Expeditor micro broker sample

This sample demonstrates the use of the Java™ Message Service (JMS) publish and subscribe messaging interfaces with the micro broker JMS provider.

JMS with Lotus Expeditor micro broker point to point sample

This sample demonstrates the use of the Java™ Message Service (JMS) point to point messaging interfaces with the micro broker JMS provider.

JNDI

This sample demonstrates the use of JNDI APIs and declarative
JNDI.

Login Configuration sample

This sample demonstrates the components and configuration needed to provide an alternative login configuration.

Managed Datasource sample

This sample demonstrates the use of the Lotus Expeditor managed datasource capability to manage updates to database definitions.

Mobile Adjuster sample

This sample demonstrates how an enterprise can extend their Web applications to mobile employees by implementing a services-oriented architecture using IBM Lotus Expeditor.

Network Status/Fault sample

This sample creates a Client Services project to illustrate the basic elements of a rich client application that uses the Network
Layer API on Lotus Expeditor.

Order Entry sample

Order Entry is a three-tier, sample application that demonstrates the following components and capabilities: Web container, Java Servlet 2.3, OSGi Preferences, MQe, JDBC, DB2e, RCP views, and preference pages.

OSGi Preferences Service sample

This sample demonstrates the use of the OSGi Preferences Service to save and retrieve preference information.

Pizza JSP sample

This sample demonstrates the usage of Java™ Server Pages (JSPs) within a web application intended for deployment on the Web Container.
The sample application is a pizza-ordering web application.

Portlet Communication sample

This sample demonstrates two JSR168 portlets exchanging data.

Rich Application sample

This sample creates a Client Services project to illustrate the basic elements of a rich application.

Rich Text Editor sample

This sample demonstrates how to include the Rich Text Editor within an Eclipse view.

Secured Web Application sample

This sample demonstrates a local, secured Web application intended for deployment on the local Web container.

Service Tracker sample

This sample creates two Client Services project to demonstrate how to use OSGi service trackers.

Simple Portlet sample

This sample demonstrates a local JSR168 portlet enabled for local portlet container.

Simple Portlet Viewer sample

This sample demonstrates the use of the Portlet Viewer, a predefined view enabling display or JSR168 and WSRP portlets. This sample demonstrates
the viewing of JSR168 portlets only.

Portlet Aggregation Web Page sample

This sample demonstrates the use of a Web page aggregation of portlets.

Property Broker sample

This sample creates a Client Services project to illustrate the basic elements of a rich client application that uses the Property
Broker API on Lotus Expeditor.

RCP Browser Basic sample

This sample creates an RCP Browser instance as an SWT widget, and embeds it into a view.

RCP Browser Advanced sample

This sample creates an RCP Browser instance as an SWT widget, and demonstrates advanced event handling.

RCP Browser with DOM Access sample

This sample creates an RCP Browser instance as an SWT widget, and demonstrates access to and manipulation of the browser DOM.

RCP Browser with DOM Access sample

This sample creates an RCP Browser instance as an SWT widget, and demonstrates access to and manipulation of the browser DOM.

Styled Widgets sample

This sample demonstrates the use of the Lotus Expeditor CSS-based Styled Widgets.

Styled Table sample

This sample demonstrates the use of the Lotus Expeditor CSS-based Styled Table in various layout configurations.

Web Application Log sample

This sample demonstrates the usage of Java™ Server Pages (JSPs) within a web application intended for deployment on the local Web
Container. The sample application displays log contents obtained from the OSGi LogReader service.

Web Application sample

This sample demonstrates the usage of Java™ Server Pages (JSPs) within a Web application intended for deployment on the local Web
Container. The sample application is a Hello World application.

XML Parser sample

This sample creates a Client Services project to demonstrate how to use a Simple API for XML (SAX) parser to get information stored
in XML files.